package ca.compsci.opent.doctool;

/**
 * An exception class that will be thrown when OpenTDoc encounters problems
 * parsing and creating documentation that isn't related to IO.
 * 
 * @since 0.0.1a
 */
public class OpenTDocException extends Exception
{
	/**
	 * Create a new {@code OpenTDocException} with standard message.
	 * 
	 * @since 0.0.1a
	 */
    public OpenTDocException()
    {
		this("An OpenTDocException has occured");
    }

	/**
	 * Create a new {@code OpenTDocException} with supplied message.
	 * 
     * @param  message the detail message (which is saved for later retrieval
     *	by the {@link #getMessage()} method).
	 * 
	 * @since 0.0.1a
	 */
    public OpenTDocException(String message)
    {
        super(message);
    }

	/**
	 * Create a new {@code OpenTDocException}  with supplied message and
	 * cause.
	 * 
     * @param  message the detail message (which is saved for later retrieval
     *	by the {@link #getMessage()} method).
     * @param  cause the cause (which is saved for later retrieval by the
     *	{@link #getCause()} method).  (A {@code null} value is
     *	permitted, and indicates that the cause is nonexistent or unknown.)
	 * 
	 * @since 0.0.1a
	 */
    public OpenTDocException(String message, Throwable cause)
    {
        super(message, cause);
    }

	/**
	 * Create a new {@code OpenTDocException} with specified cause.
	 * 
     * @param  cause the cause (which is saved for later retrieval by the
     *	{@link #getCause()} method).  (A {@code null} value is
     *	permitted, and indicates that the cause is nonexistent or unknown.)
	 * 
	 * @since 0.0.1a
	 */
    public OpenTDocException(Throwable cause)
    {
        super(cause);
    }
}
